home *** CD-ROM | disk | FTP | other *** search
- #
- # dsextras.py - Extra classes and utilities for distutils, adding
- # pkg-config support
-
-
- from distutils.command.build_ext import build_ext
- from distutils.command.install_lib import install_lib
- from distutils.command.install_data import install_data
- from distutils.extension import Extension
- import distutils.dep_util
- import fnmatch
- import os
- import re
- import string
- import sys
-
- GLOBAL_INC = []
- GLOBAL_MACROS = []
-
- def get_m4_define(varname):
- """Return the value of a m4_define variable as set in configure.in."""
- pattern = re.compile("m4_define\(" + varname + "\,\s*(.+)\)")
- if os.path.exists('configure.ac'):
- fname = 'configure.ac'
- elif os.path.exists('configure.in'):
- fname = 'configure.in'
- else:
- raise SystemExit('could not find configure file')
-
- for line in open(fname).readlines():
- match_obj = pattern.match(line)
- if match_obj:
- return match_obj.group(1)
-
- return None
-
- def getoutput(cmd):
- """Return output (stdout or stderr) of executing cmd in a shell."""
- return getstatusoutput(cmd)[1]
-
- def getstatusoutput(cmd):
- """Return (status, output) of executing cmd in a shell."""
- if sys.platform == 'win32':
- pipe = os.popen(cmd, 'r')
- text = pipe.read()
- sts = pipe.close() or 0
- if text[-1:] == '\n':
- text = text[:-1]
- return sts, text
- else:
- from commands import getstatusoutput
- return getstatusoutput(cmd)
-
- def have_pkgconfig():
- """Checks for the existence of pkg-config"""
- if (sys.platform == 'win32' and
- os.system('pkg-config --version > NUL') == 0):
- return 1
- else:
- if getstatusoutput('pkg-config')[0] == 256:
- return 1
-
- def list_files(dir):
- """List all files in a dir, with filename match support:
- for example: glade/*.glade will return all files in the glade directory
- that matches *.glade. It also looks up the full path"""
- if dir.find(os.sep) != -1:
- parts = dir.split(os.sep)
- dir = string.join(parts[:-1], os.sep)
- pattern = parts[-1]
- else:
- pattern = dir
- dir = '.'
-
- dir = os.path.abspath(dir)
- retval = []
- for file in os.listdir(dir):
- if fnmatch.fnmatch(file, pattern):
- retval.append(os.path.join(dir, file))
- return retval
-
- def pkgc_version_check(name, req_version):
- """Check the existence and version number of a package:
- returns 0 if not installed or too old, 1 otherwise."""
- is_installed = not os.system('pkg-config --exists %s' % name)
- if not is_installed:
- return 0
-
- orig_version = getoutput('pkg-config --modversion %s' % name)
- version = map(int, orig_version.split('.'))
- pkc_version = map(int, req_version.split('.'))
-
- if version >= pkc_version:
- return 1
-
- return 0
-
- class BuildExt(build_ext):
- def init_extra_compile_args(self):
- self.extra_compile_args = []
- if sys.platform == 'win32' and \
- self.compiler.compiler_type == 'mingw32':
- # MSVC compatible struct packing is required.
- # Note gcc2 uses -fnative-struct while gcc3
- # uses -mms-bitfields. Based on the version
- # the proper flag is used below.
- msnative_struct = { '2' : '-fnative-struct',
- '3' : '-mms-bitfields' }
- gcc_version = getoutput('gcc -dumpversion')
- print 'using MinGW GCC version %s with %s option' % \
- (gcc_version, msnative_struct[gcc_version[0]])
- self.extra_compile_args.append(msnative_struct[gcc_version[0]])
-
- def modify_compiler(self):
- if sys.platform == 'win32' and \
- self.compiler.compiler_type == 'mingw32':
- # Remove '-static' linker option to prevent MinGW ld
- # from trying to link with MSVC import libraries.
- if self.compiler.linker_so.count('-static'):
- self.compiler.linker_so.remove('-static')
-
- def build_extensions(self):
- # Init self.extra_compile_args
- self.init_extra_compile_args()
- # Modify default compiler settings
- self.modify_compiler()
- # Invoke base build_extensions()
- build_ext.build_extensions(self)
-
- def build_extension(self, ext):
- # Add self.extra_compile_args to ext.extra_compile_args
- ext.extra_compile_args += self.extra_compile_args
- # Generate eventual templates before building
- if hasattr(ext, 'generate'):
- ext.generate()
- # Filter out 'c' and 'm' libs when compilic w/ msvc
- if sys.platform == 'win32' and self.compiler.compiler_type == 'msvc':
- save_libs = ext.libraries
- ext.libraries = [lib for lib in ext.libraries
- if lib not in ['c', 'm']]
- else:
- save_libs = ext.libraries
- # Invoke base build_extension()
- build_ext.build_extension(self, ext)
- if save_libs != None and save_libs != ext.libraries:
- ext.libraries = save_libs
-
- class InstallLib(install_lib):
-
- local_outputs = []
- local_inputs = []
-
- def set_install_dir(self, install_dir):
- self.install_dir = install_dir
-
- def get_outputs(self):
- return install_lib.get_outputs(self) + self.local_outputs
-
- def get_inputs(self):
- return install_lib.get_inputs(self) + self.local_inputs
-
- class InstallData(install_data):
-
- local_outputs = []
- local_inputs = []
- template_options = {}
-
- def prepare(self):
- if os.name == "nt":
- self.prefix = os.sep.join(self.install_dir.split(os.sep)[:-3])
- else:
- # default: os.name == "posix"
- self.prefix = os.sep.join(self.install_dir.split(os.sep)[:-4])
-
- self.exec_prefix = '${prefix}/bin'
- self.includedir = '${prefix}/include'
- self.libdir = '${prefix}/lib'
- self.datarootdir = '${prefix}/share'
- self.datadir = '${prefix}/share'
-
- self.add_template_option('prefix', self.prefix)
- self.add_template_option('exec_prefix', self.exec_prefix)
- self.add_template_option('includedir', self.includedir)
- self.add_template_option('libdir', self.libdir)
- self.add_template_option('datarootdir', self.datarootdir)
- self.add_template_option('datadir', self.datadir)
- self.add_template_option('PYTHON', sys.executable)
- self.add_template_option('THREADING_CFLAGS', '')
-
- def set_install_dir(self, install_dir):
- self.install_dir = install_dir
-
- def add_template_option(self, name, value):
- self.template_options['@%s@' % name] = value
-
- def install_template(self, filename, install_dir):
- """Install template filename into target directory install_dir."""
- output_file = os.path.split(filename)[-1][:-3]
-
- template = open(filename).read()
- for key, value in self.template_options.items():
- template = template.replace(key, value)
-
- output = os.path.join(install_dir, output_file)
- self.mkpath(install_dir)
- open(output, 'w').write(template)
- self.local_inputs.append(filename)
- self.local_outputs.append(output)
- return output
-
- def get_outputs(self):
- return install_data.get_outputs(self) + self.local_outputs
-
- def get_inputs(self):
- return install_data.get_inputs(self) + self.local_inputs
-
- class PkgConfigExtension(Extension):
- # Name of pygobject package extension depends on, can be None
- pygobject_pkc = 'pygobject-2.0'
- can_build_ok = None
- def __init__(self, **kwargs):
- name = kwargs['pkc_name']
- kwargs['include_dirs'] = self.get_include_dirs(name) + GLOBAL_INC
- kwargs['define_macros'] = GLOBAL_MACROS
- kwargs['libraries'] = self.get_libraries(name)
- kwargs['library_dirs'] = self.get_library_dirs(name)
- if 'pygobject_pkc' in kwargs:
- self.pygobject_pkc = kwargs.pop('pygobject_pkc')
- if self.pygobject_pkc:
- kwargs['include_dirs'] += self.get_include_dirs(self.pygobject_pkc)
- kwargs['libraries'] += self.get_libraries(self.pygobject_pkc)
- kwargs['library_dirs'] += self.get_library_dirs(self.pygobject_pkc)
- self.name = kwargs['name']
- self.pkc_name = kwargs['pkc_name']
- self.pkc_version = kwargs['pkc_version']
- del kwargs['pkc_name'], kwargs['pkc_version']
- Extension.__init__(self, **kwargs)
-
- def get_include_dirs(self, names):
- if type(names) != tuple:
- names = (names,)
- retval = []
- for name in names:
- output = getoutput('pkg-config --cflags-only-I %s' % name)
- retval.extend(output.replace('-I', '').split())
- return retval
-
- def get_libraries(self, names):
- if type(names) != tuple:
- names = (names,)
- retval = []
- for name in names:
- output = getoutput('pkg-config --libs-only-l %s' % name)
- retval.extend(output.replace('-l', '').split())
- return retval
-
- def get_library_dirs(self, names):
- if type(names) != tuple:
- names = (names,)
- retval = []
- for name in names:
- output = getoutput('pkg-config --libs-only-L %s' % name)
- retval.extend(output.replace('-L', '').split())
- return retval
-
- def can_build(self):
- """If the pkg-config version found is good enough"""
- if self.can_build_ok != None:
- return self.can_build_ok
-
- if type(self.pkc_name) != tuple:
- reqs = [(self.pkc_name, self.pkc_version)]
- else:
- reqs = zip(self.pkc_name, self.pkc_version)
-
- for package, version in reqs:
- retval = os.system('pkg-config --exists %s' % package)
- if retval:
- print ("* %s.pc could not be found, bindings for %s"
- " will not be built." % (package, self.name))
- self.can_build_ok = 0
- return 0
-
- orig_version = getoutput('pkg-config --modversion %s' %
- package)
- if (map(int, orig_version.split('.')) >=
- map(int, version.split('.'))):
- self.can_build_ok = 1
- return 1
- else:
- print "Warning: Too old version of %s" % self.pkc_name
- print " Need %s, but %s is installed" % \
- (package, orig_version)
- self.can_build_ok = 0
- return 0
-
- def generate(self):
- pass
-
- # The Template and TemplateExtension classes require codegen which is
- # currently part of the pygtk distribution. While codegen might ultimately
- # be moved to pygobject, it was decided (bug #353849) to keep the Template
- # and TemplateExtension code in dsextras. In the meantime, we check for the
- # availability of codegen and redirect the user to the pygtk installer if
- # he/she wants to get access to Template and TemplateExtension.
-
- template_classes_enabled=True
- codegen_error_message="""
- ***************************************************************************
- Codegen could not be found on your system and is required by the
- dsextras.Template and dsextras.TemplateExtension classes. codegen is part
- of PyGTK. To use either Template or TemplateExtension, you should also
- install PyGTK.
- ***************************************************************************
- """
- try:
- from codegen.override import Overrides
- from codegen.defsparser import DefsParser
- from codegen.codegen import register_types, SourceWriter, \
- FileOutput
- import codegen.createdefs
- except ImportError, e:
- template_classes_enabled=False
-
- class Template(object):
- def __new__(cls,*args, **kwds):
- if not template_classes_enabled:
- raise NameError("'%s' is not defined\n" % cls.__name__
- + codegen_error_message)
- return object.__new__(cls,*args, **kwds)
-
- def __init__(self, override, output, defs, prefix,
- register=[], load_types=None, py_ssize_t_clean=False):
-
- self.override = override
- self.output = output
- self.prefix = prefix
- self.load_types = load_types
- self.py_ssize_t_clean = py_ssize_t_clean
-
- self.built_defs=[]
- if isinstance(defs,tuple):
- self.defs=defs[0]
- self.built_defs.append(defs)
- else:
- self.defs=defs
-
- self.register=[]
- for r in register:
- if isinstance(r,tuple):
- self.register.append(r[0])
- self.built_defs.append(r)
- else:
- self.register.append(r)
-
- def check_dates(self):
- # Return True if files are up-to-date
- files=self.register[:]
- files.append(self.override)
- files.append(self.defs)
-
- return not distutils.dep_util.newer_group(files,self.output)
-
- def generate_defs(self):
- for (target,sources) in self.built_defs:
- if distutils.dep_util.newer_group(sources,target):
- # createdefs is mostly called from the CLI !
- args=['dummy',target]+sources
- codegen.createdefs.main(args)
-
-
- def generate(self):
- # Generate defs files if necessary
- self.generate_defs()
- # ... then check the file timestamps
- if self.check_dates():
- return
-
- for item in self.register:
- dp = DefsParser(item,dict(GLOBAL_MACROS))
- dp.startParsing()
- register_types(dp)
-
- if self.load_types:
- globals = {}
- execfile(self.load_types, globals)
-
- dp = DefsParser(self.defs,dict(GLOBAL_MACROS))
- dp.startParsing()
- register_types(dp)
-
- fd = open(self.output, 'w')
- sw = SourceWriter(dp,Overrides(self.override),
- self.prefix,FileOutput(fd,self.output))
- sw.write(self.py_ssize_t_clean)
- fd.close()
-
- class TemplateExtension(PkgConfigExtension):
- def __new__(cls,*args, **kwds):
- if not template_classes_enabled:
- raise NameError("'%s' is not defined\n" % cls.__name__
- + codegen_error_message)
- return PkgConfigExtension.__new__(cls,*args, **kwds)
-
- def __init__(self, **kwargs):
- name = kwargs['name']
- defs = kwargs['defs']
- if isinstance(defs,tuple):
- output = defs[0][:-5] + '.c'
- else:
- output = defs[:-5] + '.c'
- override = kwargs['override']
- load_types = kwargs.get('load_types')
- py_ssize_t_clean = kwargs.pop('py_ssize_t_clean',False)
- self.templates = []
- self.templates.append(Template(override, output, defs, 'py' + name,
- kwargs['register'], load_types,
- py_ssize_t_clean))
-
- del kwargs['register'], kwargs['override'], kwargs['defs']
- if load_types:
- del kwargs['load_types']
-
- if kwargs.has_key('output'):
- kwargs['name'] = kwargs['output']
- del kwargs['output']
-
- PkgConfigExtension.__init__(self, **kwargs)
-
- def generate(self):
- map(lambda x: x.generate(), self.templates)
-
-
-